home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 25 / Cream of the Crop 25.iso / bbs / muep014.zip / MUE.DOC < prev    next >
Text File  |  1997-03-27  |  13KB  |  279 lines
  1. ┌──────────────────────────────────────────────────────────────────────────────┐
  2. │  MUE Maximus User Editor v0.14wb   ∙   Documentation   ∙  Wide Beta Version  │
  3. └──────────────────────────────────────────────────────────────────────────────┘
  4.  
  5.   As much as I have tried to make this program usable without docs, it
  6.   has become necessary due to the complexity of the beast.  As they say,
  7.   documentation is the worst part for a programmer and I guess I'm no
  8.   exception to this saying...  Hopefully I have covered the basics with-
  9.   out boring you too much in this file.
  10.  
  11.   Keys and their uses:
  12.  
  13.     For the most part this section is a long winded version the MUE.HLP
  14.     file included in the archive.  However some keys may not be listed in
  15.     the help file and perhaps some more detail on the keys and uses may
  16.     be of help here.
  17.  
  18.     = (equal) - Toggles the displaying of user passwords.  Note that
  19.                 sysop level user passwords are not displayed.  This
  20.                 is a minor security attempt for prying eyes.  In all
  21.                 cases (except when encrypted passwords are used) the
  22.                 password is displayed when editing a password.
  23.     ^P or |   - (Control-P)  Packs/Purges the user base.
  24.     ^R        - (Control-R)  Restore purged users.
  25.     ^S        - (Control-S)  Sort the user base.
  26.     ALT-(Key) - This toggles the current users (key).  Example ALT-K
  27.                 toggles the K key.
  28.     ESC       - Toggles the main menu.
  29.     F1        - Displays the MUE.HLP (help) text file.
  30.     PageDn    - Jump/decrement 10 users down from the current user.
  31.     PageUp    - Jump/increment 10 users up from the current user.
  32.     Dn or Rt  - Display the next user record.
  33.     Up or LF  - Display the previous user record.
  34.     1 or Home - Jumps to the first user record.
  35.     A         - Change the current users access level.
  36.     C         - Change the current users compression method.
  37.     D or DEL  - Toggles the Delete flag for the current user.
  38.     E         - Edit non hotkey fields.
  39.     F         - Change the current users flags.
  40.     G#        - Go to user #.
  41.     H         - Change the current users Help Level.
  42.     J or END  - Jumps to the last user record.
  43.     K         - Change the current users keys.  Using this option will
  44.                 display the key values as set in the Configuration >
  45.                 Key Labels menu option.  Keys can also be toggled by
  46.                 pressing ALT-(key).  See ALT-(Key) above.
  47.     L         - Change the current users Language.
  48.     N         - Change the current users Nulls.
  49.     P         - Toggle the current users PERM flag.
  50.     R         - Change the current users Message/File Area.
  51.     S         - Search menu.
  52.     T         - Change the current users Transfer protocol.
  53.     V         - Change the current users Video Mode.
  54.     W         - Change the current users Password.
  55.     X         - Change the current users EXpiration settings.
  56.  
  57.   Command Line Switches:
  58.  
  59.     First off, you can run MUE and pass the /H switch for the command
  60.     line switch help.  This yields basic help/instructions for the
  61.     different switches.
  62.  
  63.     /B      This runs MUE in Monochrome mode.  Essentially Black & White.
  64.  
  65.     /C      Configuration file switch.  This allows you to specify a path
  66.             and file name to your .CFG file.  Useful for having multiple
  67.             configuration files or keeping the .CFG file in a directory
  68.             other than the \MAX directory.  Usage: MUE /Cc:\max\mue.cfg.
  69.  
  70.     /G###   Go to user ###.
  71.  
  72.     /M      Maximus .PRM switch, default is the MAXIMUS environment
  73.             variable.  Use this to override or replace the MAXIMUS
  74.             environment variable.  Usage:  MUE /Mc:\max\max.prm.
  75.  
  76.     /P      Purge the USER base.  This will purge users based on settings
  77.             in the Global > Purge Settings menu as well as users marked
  78.             deleted.  Useful in nightly maintenance batches.
  79.  
  80.     /Sm[s]  Sort the user base.  This switch will sort the user base and
  81.             save it that way.  Useful in nightly maintenance batches.
  82.             The m field is the Major sort option and s is the optional
  83.             secondary sort option.  Keys for these are simply the hotkey
  84.             characters used within the Sort menu as shown below:
  85.  
  86.                 1 = 1st  Name       M = Message Area
  87.                 L = Last Name       B = DOB
  88.                 A = AccessLvl       I = AlIas
  89.                 C = City            S = LaSt Call
  90.                 P = Phone #         # = # Calls
  91.                 T = DaTa #          D = DnLoad Kb
  92.                 F = File Area       U = UpLoad Kb
  93.  
  94.             For example:  MUE /Sal
  95.  
  96.             Will sort the user base by Access level and then by last name
  97.             as a secondary sort within the access levels.  Note that you
  98.             may have mixed results with the secondary sort option.  Some
  99.             major sorts don't lend well to secondary sorts.  This was
  100.             implemented mostly for sorting by names within the Access
  101.             level sort.
  102.  
  103.     /U      User base switch.  Use this to override the MAX.PRM setting.
  104.             Useful for testing purposes more than anything else.
  105.  
  106.   Files used/created by MUE:
  107.  
  108.     First of all MUE requires a Maximus version 3.0x USER.BBS file,
  109.     second it requires your MAX.PRM file.  Due to the flexibility of
  110.     Maximus 3.0x, the MAX.PRM file is an absolute necessity for MUE.
  111.     For this reason, you must have an environment variable set for
  112.     Maximus or you need to pass the path and file name to your MAX.PRM
  113.     file.  See the command line switch, /M, on how to pass it to MUE.
  114.  
  115.     Other files used/created are MUE.CFG, MUE.HLP, USER.BAK, USER.EXT,
  116.     USER.EXB, and USER.PRG.
  117.  
  118.     MUE.CFG is where your configuration settings are stored.
  119.  
  120.     MUE.HLP is a flat ASCII text file that is displayed when F1 is
  121.     pressed. This file can be custom configured to suit your personal
  122.     needs, the only limitation are the file cannot exceed 21 lines or
  123.     have lines longer than 80 characters.  Any text outside of these
  124.     limits are simply truncated.
  125.  
  126.     USER.BAK is created when packing or purging the user base.  It's
  127.     simply a backup of your USER.BBS file prior to packing/purging.
  128.  
  129.     USER.EXT is where MUE stores any user descriptions.  This file is
  130.     compatible with UEDIT, so if you used it with UED then you'll still
  131.     have your descriptions.
  132.  
  133.     USER.EXB is simply a backup of the USER.EXT file prior to packing/
  134.     purging users.
  135.  
  136.   Configuration - Color Options:
  137.  
  138.     This option may be misleading, you cannot actually set colors per se,
  139.     rather you can only choose predefined color settings.  Mono is the
  140.     choice for monochrome monitors.  Color1 or Color2 are of course for
  141.     systems with a color monitor.
  142.  
  143.   Configuration - Date Format:
  144.  
  145.     Here's where you choose your date format for any displayed date field.
  146.     Choices are MM/DD/YY, DD/MM/YY, or YY/MM/DD.
  147.  
  148.   Configuration - Key Labels:
  149.  
  150.     Here's where you can define the purpose of the keys as used on your
  151.     system.  The definitions are displayed when you choose the 'K' Keys
  152.     hotkey while viewing a user record.  They're displayed in the Expire
  153.     field (above the Keys field).
  154.  
  155.   Configuration - Show Password:
  156.  
  157.     This option toggles whether or not passwords are displayed while
  158.     viewing user records.  This can be toggled via the '=' key as well.
  159.     Note that Sysop level users passwords are not displayed.  This is a
  160.     minor attempt at security for any prying eyes.  If you really need
  161.     to view a Sysop level users password then you need to edit it using
  162.     the W hotkey.  You can of course just press ESC to abort any changes
  163.     to leave it alone.
  164.  
  165.   Configuration - SOund:
  166.  
  167.     This option toggles sound, some pop-up boxes beep if on.
  168.  
  169.   Configuration - SaVe Settings:
  170.  
  171.     Save your settings to the MUE.CFG file.  All settings in the
  172.     Configuration as well as the Global > Key and Global > Purge
  173.     Settings menus are saved via this option.
  174.  
  175.   File - Append Record:
  176.  
  177.     This menu choice allows you to add a new user record.  It defaults to
  178.     a user name of "New Record Created by MUE".  Default settings via
  179.     Maximus are also set, such as Message area, File area, and Access
  180.     level.  It's up to you to fill in the blanks beyond this.
  181.  
  182.   File - Pack User File:
  183.  
  184.     Pack/Purge the user base file.  Settings in the Global > Purge
  185.     Settings are also processed with this choice.
  186.  
  187.   File - Restore a User:
  188.  
  189.     Have you ever deleted a user and wished there a way to put them
  190.     back?  If so, then look no further!  :-)  You now have the ability to
  191.     do it assuming you used MUE to delete/purge it.
  192.  
  193.     Choosing this option loads the USER.PRG file and allows you to TAG
  194.     user(s) to restore.  After tagging (pressing the space bar), press
  195.     escape and you'll be prompted to restore them.  Keep in mind that any
  196.     descriptions you may have had for the user(s) were lost in the pack/
  197.     purge process and cannot be restored.
  198.  
  199.   Global - Key Settings:
  200.  
  201.     This menu choice allows you to do a mass/global change on users keys.
  202.     First you need to choose which access levels to act on, second is the
  203.     keys you want to turn on or off.
  204.  
  205.     It should be straight forward for the access levels, either they're ON
  206.     or OFF.  ON means they're processed, OFF are not.
  207.  
  208.     Key settings are -, ON, or OFF.  Key(s) set to '-' are ignored, keys
  209.     set to ON are turned on for all access levels set to ON, and keys set
  210.     to OFF are turned off for access levels set to ON.
  211.  
  212.     Once you make your choices, pressing control-P prompts you to process
  213.     them.
  214.  
  215.   Global - Purge Settings:
  216.  
  217.     This menu is where you set the purge settings.  Access levels set to
  218.     NO are not processed.
  219.  
  220.     If an Access level is set to YES then MUE looks at the number of days.
  221.     Users that have called less than number of DAYS are purged unless
  222.     they have exceeded the number of CALLS.
  223.  
  224.     Note that values of 0 for DAYS or CALLS are ignored.  Here's some
  225.     examples:
  226.  
  227.       ACS = NO                           This level is ignored completely,
  228.                                          regardless of DAYS or CALLS.
  229.  
  230.       ACS = YES  DAYS =  0  CALLS =  0   This level is ignored completely,
  231.                                          because DAYS are set to 0 and
  232.                                          CALLS are also set to 0.
  233.  
  234.       ACS = YES  DAYS = 10  CALLS =  0   Callers in this level are purged
  235.                                          if they haven't called for 10
  236.                                          days or longer regardless of how
  237.                                          many times they have called.
  238.  
  239.       ACS = YES  DAYS = 30  CALLS = 10   Callers in this level are purged
  240.                                          if they haven't called for 30
  241.                                          days or more and have only called
  242.                                          10 or less times.
  243.  
  244.   Global - Save As Sorted:
  245.  
  246.     This option is only available if the user base has been sorted.  This
  247.     will save the user base as sorted.
  248.  
  249.   Global - Sort User File:
  250.  
  251.     Here's where you can sort the user base.  This does a sort of the base
  252.     in memory, if you want to save the base as sorted then you need to use
  253.     the Global > Save As Sorted menu option.  Otherwise the sort isn't
  254.     saved.
  255.  
  256.     There is an option to sort on a secondary field.  Highlight the field
  257.     you want to sort as a secondary basis and press the space bar.  This
  258.     will mark the field with >< characters to indicate your choice.
  259.  
  260.     Highlighting a field and pressing enter will sort the user base based
  261.     on the field highlighted.  Secondary sorts are based on the fields
  262.     surrounded by the >< characters.
  263.  
  264.   Credits:
  265.  
  266.     Before I forget, I have to give credit to Gary Zarzycki for a lot of
  267.     the nuts and bolts in this program.  There are too many to list here,
  268.     but suffice it to say that were it not for him this program wouldn't
  269.     be where it is now (if ever), thanks Gary!
  270.  
  271.     For the second color option, I thank Gary Gilmore.  I liked it so much
  272.     I bought the company!  :-)  Okay I just implemented the colors, but I
  273.     do like them more than my original choice.  See the COLOR2 option in
  274.     the Config Menu > Color Options for his suggestion.
  275.  
  276.     And of course I can't forget Scott Dudley for creating and maintaining
  277.     Maximus, thanks Scott!
  278.  
  279.